IRIX Base Documentation 1998 November/IRIX 6.5.2 Base Documentation November 1998.img/usr/share/catman/p_man/cat3/ifl/iflFileConfig.z/iflFileConfig

Text File | 1998-10-20 | 13KB | 331 lines

iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



NNNNAAAAMMMMEEEE
     iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg - iflFile configuration descriptor

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <ifl/iflFileConfig.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     iflFileConfig describes the configuration of an iflFile; it is used with
     the iiiiffffllllFFFFiiiilllleeee::::::::ccccrrrreeeeaaaatttteeee(((()))) and iiiiffffllllFFFFoooorrrrmmmmaaaatttt::::::::aaaappppppppllllyyyyDDDDeeeeffffaaaauuuullllttttssss(((()))) calls.  The image
     and page size parameters are always expressed with conventional (x ==
     width, y == height) orientation, regardless of the value of the
     orientation parameter.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr

          iflFileConfig(const iflSize* imagedims=NULL,
                        iflDataType datatype = iflDataType(0),
                        iflOrder dimensionorder = iflOrder(0),
                        iflColorModel colormodel = iflColorModel(0),
                        iflOrientation orientation = iflOrientation(0),
                        iflCompression compression = iflCompression(0),
                        const iflSize* pagedims = NULL)
          iflFileConfig(iflFile* file)

     GGGGeeeetttt////sssseeeetttt iiiinnnnppppuuuutttt mmmmeeeetttthhhhooooddddssss

          void setDimensions(const iflSize& imagedims)
          void setDataType(iflDataType datatype)
          void setOrder(iflOrder dimensionorder)
          void setColorModel(iflColorModel colormodel)
          void setOrientation(iflOrientation orientation)
          void setCompression(iflCompression compression)
          void setPageDimensions(const iflSize& pagedims)
          void getDimensions(iflSize& imagedims)
          const iflSize& getDimensions()
          void getSize(iflSize& imagesize)
          iflDataType getDataType()
          iflOrder getOrder()
          iflColorModel getColorModel()
          iflOrientation getOrientation()
          iflCompression getCompression()
          void getPageDimensions(iflSize& pagedims)
          const iflSize& getPageDimensions()
          void getPageSize(iflSize& pagesize)

     QQQQuuuueeeerrrryyyy mmmmeeeetttthhhhooooddddssss





                                                                        PPPPaaaaggggeeee 1111






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          int areDimensionsDefaulted()
          int isDataTypeDefaulted()
          int isOrderDefaulted()
          int isColorModelDefaulted()
          int isOrientationDefaulted()
          int isCompressionDefaulted()
          int arePageDimensionsDefaulted()


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg(((())))

          iflFileConfig(const iflSize* imagedims=NULL,
                        iflDataType datatype = iflDataType(0),
                        iflOrder dimensionorder = iflOrder(0),
                        iflColorModel colormodel = iflColorModel(0),
                        iflOrientation orientation = iflOrientation(0),
                        iflCompression compression = iflCompression(0),
                        const iflSize* pagedims = NULL)


          This constructor creates a fully initialized iflFile configuration
          descriptor.  Defaulted attributes can be set later with the various
          set methods.

     aaaarrrreeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssssDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int areDimensionsDefaulted()


          This method returns true if any of the image dimensions have been
          defaulted.

     aaaarrrreeeePPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssssDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int arePageDimensionsDefaulted()


          This method returns true if any of the page dimensions have been
          defaulted.

     ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          iflColorModel getColorModel()


          This method returns the value of the color model parameter.

     ggggeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))






                                                                        PPPPaaaaggggeeee 2222






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          iflCompression getCompression()


          This method returns the value of the compression parameter.

     ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          iflDataType getDataType()


          This method returns the value of the data type parameter.

     ggggeeeettttDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void getDimensions(iflSize& imagedims)


          This method returns the value of the image dimensions parameter.

     ggggeeeettttOOOOrrrrddddeeeerrrr(((())))

          iflOrder getOrder()


          This method returns the value of the dimension order parameter.

     ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          iflOrientation getOrientation()


          This method returns the value of the orientation parameter.

     ggggeeeettttPPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void getPageDimensions(iflSize& pagedims)


          This method returns the value of the page dimensions parameter.

     ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee(((())))

          void getPageSize(iflSize& pagesize)


          This method returns the value of the page dimensions parameter.

     ggggeeeettttSSSSiiiizzzzeeee(((())))

          void getSize(iflSize& imagesize)





                                                                        PPPPaaaaggggeeee 3333






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          This method returns the image dimensions, transposing them if the
          orientation is transposed.

     iiiissssCCCCoooolllloooorrrrMMMMooooddddeeeellllDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int isColorModelDefaulted()


          This method returns true if the color model parameter is defaulted.

     iiiissssCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int isCompressionDefaulted()


          This method returns true if the compression parameter is defaulted.

     iiiissssDDDDaaaattttaaaaTTTTyyyyppppeeeeDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int isDataTypeDefaulted()


          This method returns true if the data type parameter is defaulted.

     iiiissssOOOOrrrrddddeeeerrrrDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int isOrderDefaulted()


          This method returns true if the dimension order parameter is
          defaulted.

     iiiissssOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnnDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int isOrientationDefaulted()


          This method returns true if the orientation parameter is defaulted.

     sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          void setColorModel(iflColorModel colormodel)


          This method sets the value of the color model parameter to
          _c_o_l_o_r_m_o_d_e_l.

     sssseeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))

          void setCompression(iflCompression compression)





                                                                        PPPPaaaaggggeeee 4444






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          This method sets the value of the compression parameter to
          _c_o_m_p_r_e_s_s_i_o_n.

     sssseeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          void setDataType(iflDataType datatype)


          This method sets the value of the data type parameter to _d_a_t_a_t_y_p_e.

     sssseeeettttDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void setDimensions(const iflSize& imagedims)


          This method sets the value of the image dimension parameter to
          _i_m_a_g_e_d_i_m_s.

     sssseeeettttOOOOrrrrddddeeeerrrr(((())))

          void setOrder(iflOrder dimensionorder)


          This method sets the value of the dimension order parameter to
          _d_i_m_e_n_s_i_o_n_o_r_d_e_r.

     sssseeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          void setOrientation(iflOrientation orientation)


          This method sets the value of the orientation parameter to
          _o_r_i_e_n_t_a_t_i_o_n.

     sssseeeettttPPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void setPageDimensions(const iflSize& pagedims)


          This method sets the value of the page dimension parameter to
          _p_a_g_e_d_i_m_s.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     iflFile(3), iflFormat(3)











                                                                        PPPPaaaaggggeeee 5555